Saltar al contenido principal

Como crear un Retiro

POST - https://url.base/api/withdrawal/pix/new
Endpoint para crear una nuevo retiro. Para crear una nueva solicitud de retiro,
la solicitud debe construirse con los siguientes parámetros.
(*) Información requerida..
CampoTipoDescripción
*amountIntegerMonto de la transacción.
*document_idStringDocumento de identidad del beneficiario
*beneficiaryNameIntegerNombre completo del beneficiario
*beneficiaryLastNameStringApellido del beneficiario
*beneficiaryEmailStringCorreo electrónico del beneficiario
*beneficiaryPhoneStringNúmero de teléfono del beneficiario.
*accountNumberStringNúmero de cuenta bancaria
*accountTypeStringTipo de cuenta bancaria
*bankCodeStringCódigo bancario
*dataStringIdentificador del Retiro a asociar. El campo "data" debe ser único e irrepetible
*confirmationURLLinkURL para la confirmación de la transacción
*currencyStringCódigo de moneda ISO. # Países y monedas​​
*countryStringFormato de país internacional. # Países y monedas​​
*signStringLa firma de los parámetros es única para cada transacción
*pagamentoTypeIntegerEste es el campo diferenciador al solicitar un retiro PIX. El Valor (1) corresponde a un retiro con una cuenta bancaria, mientras que el Valor (2) es un retiro con una clave PIX
*TypeStringEste campo diferencia qué tipo de PIX se utilizará al generar el retiro, y se debe distinguir por 'document_id (CPF)' o 'beneficiaryEmail' o 'beneficiaryPhone'
accountNumberStringNúmero de cuenta bancaria (Solo tipo de pago 1)
agencyStringSucursal bancaria brasileña donde se realizará el retiro para el tipo de pago 2, retiro a cuenta bancaria (Solo tipo de pago 1)
ispbStringla ispbParticipante de la institución financiera asociada al contacto. (Solo tipo de pago 1)
info

Una vez que el usuario haya completado el proceso de retiro, ProntoPaga devolverá los datos a la URL que hayas especificado en la urlConfirmación

Response OK

{
"uid" = [string] // Identificador de retirada en el sistema,
"status" = [string] // Estado del retiro,
"data" = [string] // Datos adicionales de la transacción
}

Status response

CampoDescripción
200 -201: OKRetiro creado con éxito
401: UnauthorizedPermiso denegado